Add ADAPTIVE_V2 retry mode to support the legacy behavior #5123
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sugmanue
changed the title
|
dagnir
reviewed
Apr 30, 2024
Comment on lines
88
to
89
| * from remembering its state across requests which is needed to correctly estimate its sending rate. Given that the | ||
| * this bug has been present since its introduction and that correct version might change the traffic patterns of the SDK we |
| * @deprecated As of 2.25.xx, replaced by {@link #ADAPTIVE_V2}. The ADAPTIVE implementation has a bug that prevents it | ||
| * from remembering its state across requests which is needed to correctly estimate its sending rate. Given that the | ||
| * this bug has been present since its introduction and that correct version might change the traffic patterns of the SDK we | ||
| * deemed too risky to fix this implementation.. |
Comment on lines
101
to
105
| * Adaptive V2 mode differs from {@link #ADAPTIVE} mode in the computed delays between calls, including the fist attempt | ||
| * that might be delayed if the algorithm considers that it's needed to increase the odds of a successful response. The | ||
| * previous Adaptive mode is also designed to work like so but a bug present since its introduction prevents it from | ||
| * preserving its internal state across requests. | ||
| * <p> |
There was a problem hiding this comment.
s/fist/first/
Also should "Adaptive" be capitalized?
The
* previous Adaptive mode is also designed to work like so but a bug present since its introduction prevents it from
* preserving its internal state across requests.
I don't think it's necessary to specify that ADAPTIVE is also supposed to work this. If we link back to ADAPTIVE from here I think that's sufficient
Comment on lines
116
to
119
| if (retryMode == RetryMode.ADAPTIVE_V2) { | ||
| throw new UnsupportedOperationException("ADAPTIVE_V2 is not supported by retry policies, use a RetryStrategy " | ||
| + "instead"); | ||
| } |
There was a problem hiding this comment.
Can we move this check to Builder instead?
There was a problem hiding this comment.
I moved this to the builder, not sure what's the reason behind it but I guess it's the same.
dagnir
approved these changes
May 1, 2024
sugmanue
added a commit
that referenced
this pull request
Jun 11, 2024
* New API for the retries module (#3769) This new module includes the interfaces and classes that will be used to implement the new retry logic within the SDK. * Add default backoff strategies (#3906) * Add default backoff strategies * Moved the backoff strategires to the SPI package * Use AssertJ instead of Hamcrest * Add standard retry strategy (#3931) * Add standard retry strategy * Fix the AcquireInitialTokenRequestImpl API annotation Also add the package to the test/tests-coverage-reporting/pom.xml to get coverage reporting * Add adaptive retry strategy (#3975) * Add adaptive retry strategy * Address pull request comments * Address PR comments * Address PR comments * Update retries and retries-api to snapshot version: 2.20.64-SNAPSHOT * Fix SonarCloud code smells (#3991) * Fix SonarCloud code smells * Move AdaptiveRetryStrategyResourceConstrainedTest to an integration test This change is to workaround the SonarCloud code smell of the Sleep usage in this test * Add legacy retry strategy (#3988) * Add legacy retry strategy * Remove public modifiers from test classes to make SonarCloud happy * Fix another SonarCloud code smell * WIP * Address PR comments * Rename all the strategies to use Default prefix instead of Impl suffix * Address PR comments * Remove those tests that are now part of a different class * Update version after merge from master * Refactor retry strategies (#4039) * Refactor the retry strategies This change uses a single class to implement the core logic of all the retries strategies and adds extension points to tailor the behavior when needed. * Rename to BaseRetryStrategy and make it abstract * Remove previous implementations and rename the new ones * Update sdk version * Fix the retry condition to just look for the initial cause * Add new sync and async retryable stages (#4062) * Add new sync and async retryable stages * Address PR comments * Update sdk version * Change uses of RetryPolicy to RetryStrategy (#4125) * Update sdk version * Deprecate legacy classes and use new when possible (#4154) * Deprecate legacy classes and use new when possible * Fix checkstyle and add some more validation * Add missing @deprecated annotation * Add missing dependency to the retries-api module * Fix minor logging issues * Update sdk version * Add support for retryable trait (#4170) * Merge master * Update to support plugins * Add support for AWS retryable conditions * Use the correct token bucket exception cost value * Add ADAPTIVE_V2 retry mode to support the legacy behavior (#5123) * Add a new ADAPTIVE2 mode to support the legacy behavior * Fix dynamodb test to use adaptive2 mode * Fixes and tests for the expected behaviors * Rename the new adaptive mode to ADAPTIVE_V2 * More fixes related to the rename from adaptive2 to adaptive_v2 * Fix dynamodb retry resolver logic for adaptive mode * Properly clean up the test state * Address PR comments * Remove a small typo * Dumy commit * Dummy commit to kick the internal build * Rename retries-api to retries-spi * Add retry packages to brazil (#5215) * Add retry packages to brazil * Update pom's as per the new module checklist * Remove type params from RetryStrategy, but keep them in RetryStrategy… (#5262) * Remove type params from RetryStrategy, but keep them in RetryStrategy.Builder * Rename from `none` to `doNotRetry` to clarify the behavior * External names used for retry modes only support 'adaptive' (#5265) * Externally named retry modes only support 'adaptive' Behind the scenes this will be mapped to RetryMode.ADAPTIVE_V2 which makes it a non-backwards compatible behavioral change. * Sneak in a fix from the previous PR * Fix a test that expects adaptive to map to `RetryMode.ADAPTIVE` * Fix typos in the comments * Retries release (#5280) * Bump version to 2.26.0-SNAPSHOT * Add retry release changlog entry * Add missing deprecation annotation and javadoc tag * Archive the last changelog from the 2.25 series --------- Co-authored-by: John Viegas <70235430+joviegas@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This change is aimed to prevent breaking existing users of the legacy adaptive mode while introducing the means needed for new users to onboard and use the correct adaptive implementation.
Modifications
This change introduces a new
RetryModeconstant,ADAPTIVE_V2and uses the legacyADAPTIVEretry policy by adapting it to a retry strategy using the existing adapter when theADAPTIVEmode is requested, either by usingAwsRetryStrategy.forRetryMode(RetryMode.ADAPTIVE)call, or by setting theretry_mode=adaptivevalue in the profile file or by using theaws.retryMode=ADAPTIVEsystem setting.Customers that need or want the correct adaptive mode will need to use instead
RetryMode.ADAPTIVE_V2. This will reduce the risk of breaking customers that are using the legacy mode.Testing
Added unit tests to validate that all the current ways of configuring the retry logic in the SDK will create the expected and correct instance that implements the desired logic.
Screenshots (if appropriate)
Types of changes
Checklist
mvn installsucceedsscripts/new-changescript and following the instructions. Commit the new file created by the script in.changes/next-releasewith your changes.License